Okapi.setupSites - Code Metrics - Inspection of "fixed Okapi.removeMarkers. fixes #64" - flopp/FloppsMap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 92186c...418fbb )

by Florian

created 2016-07-28 18:04 UTC

Okapi.setupSites A

↳ Parent: js/okapi.js

Complexity

Conditions	2
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	2
c	1
b	1
f	0
nc	3
nop	0
dl	0
loc	60
rs	9.5555

1 Function

Rating	Name	Duplication	Size	Complexity
B		0	27	4

How to fix Long Method

/*jslint
  indent: 4
*/

/*global
  $, google, mytrans, window, Cookies, Coordinates, get_cookie_string
*/


var Okapi = {};
Okapi.m_map = null;
Okapi.m_sites = null;
Okapi.m_ready = false;
Okapi.m_showCache = null;
Okapi.m_enabled = false;
Okapi.m_popup = null;
Okapi.m_marker = null;
Okapi.m_icons = null;
Okapi.m_timer = null;


Okapi.init = function (themap) {
    'use strict';

    this.m_map = themap;
    var self = this;

    google.maps.event.addListener(this.m_map, "center_changed", function () {
        self.scheduleLoad();
    });
    google.maps.event.addListener(this.m_map, "zoom_changed", function () {
        self.scheduleLoad();
    });
};


Okapi.parseLocation = function (s) {
    'use strict';

    var loc = s.split("|"),
        lat = parseFloat(loc[0]),
        lng = parseFloat(loc[1]);

    if (Coordinates.valid(lat, lng)) {
        return new google.maps.LatLng(lat, lng);
    }

    return null;
};


Okapi.setShowCache = function (code) {
    'use strict';

    this.m_showCache = code;
};


Okapi.setupSites = function () {
    'use strict';

    if (this.m_sites) {
        return;
    }

    var self = this,
        main_url = "http://www.opencaching.pl/okapi/services/apisrv/installations",
        keys = {
            "Opencaching.DE" : "YSqPufH82encfJ67ZxV2",
            "Opencaching.PL" : "jhRyc6rGmT6XEvxva29B",
            "Opencaching.NL" : "gcwaesuq3REu8RtCgLDj",
            "Opencaching.US" : "GvgyCMvwfH42GqJGL494",
            "Opencaching.ORG.UK" : "7t7VfpkCd4HuxPabfbHd",
            "Opencaching.RO" : "gqSWmVJhZGDwc4sRhyy7"
        },
        prefixes = {
            "Opencaching.DE" : "OC",
            "Opencaching.PL" : "OP",
            "Opencaching.NL" : "OB",
            "Opencaching.US" : "OU",
            "Opencaching.ORG.UK" : "OK",
            "Opencaching.RO" : "OR"
        };

    this.m_sites = [];

    $.ajax({
        url: main_url,
        dataType: 'json',
        success: function (response) {
            response.map(function (site) {
                if (keys[site.site_name] !== undefined) {
                    //console.log("adding OC site: " + site.site_name);
                    self.m_sites.push({
                        siteid: self.m_sites.length,
                        name: site.site_name,
                        site_url: site.site_url,
                        url: site.okapi_base_url,
                        prefix: prefixes[site.site_name],
                        key: keys[site.site_name],
                        ignore_user: null,
                        markers: {},
                        finished: true
                    });
                }
            });

            self.m_ready = true;
            if (self.m_enabled) {
                self.scheduleLoad(true);
            }
            if (self.m_showCache && self.m_showCache !== "") {
                self.centerMap(self.m_showCache);
                self.m_showCache = null;
            }
        }
    });
};


Okapi.setupIcons = function () {
    'use strict';

    if (this.m_icons) {
        return;
    }

    this.m_icons = {
        "Other": new google.maps.MarkerImage("img/cachetype-1.png"),
        "Traditional": new google.maps.MarkerImage("img/cachetype-2.png"),
        "Multi": new google.maps.MarkerImage("img/cachetype-3.png"),
        "Virtual": new google.maps.MarkerImage("img/cachetype-4.png"),
        "Webcam": new google.maps.MarkerImage("img/cachetype-5.png"),
        "Event": new google.maps.MarkerImage("img/cachetype-6.png"),
        "Quiz": new google.maps.MarkerImage("img/cachetype-7.png"),
        "Math/Physics": new google.maps.MarkerImage("img/cachetype-8.png"),
        "Moving": new google.maps.MarkerImage("img/cachetype-9.png"),
        "Drive-In": new google.maps.MarkerImage("img/cachetype-10.png")
    };
};


Okapi.icon = function (type) {
    'use strict';

    if (this.m_icons[type] !== undefined) {
        return this.m_icons[type];
    }

    return this.m_icons.Other;
};


Okapi.guessSiteId = function (code) {
    'use strict';

    code = code.toUpperCase();
    var siteid;
    for (siteid = 0; siteid < this.m_sites.length; siteid += 1) {
        if (code.startsWith(this.m_sites[siteid].prefix)) {
            return siteid;
        }
    }

    return -1;
};


Okapi.centerMap = function (code) {
    'use strict';

    if (!this.m_ready) {
        //console.log("okapi not ready");
        return;
    }

    var siteid = this.guessSiteId(code);
    if (siteid < 0) {
        //console.log("bad code. cannot determine okapi site");
        return;
    }

    this.showPopup(null, code.toUpperCase(), siteid);
};


Okapi.createPopupContent = function (code, response) {
    'use strict';

    var content =
        '<a href="' + response.url + '" target="_blank">' + code + ' <b>' + response.name + '</b></a><br />'
        + '<table>'
        + '<tr><td>' + mytrans("geocache.owner") + '</td><td>' + '<a href="' + response.owner.profile_url + '" target="_blank"><b>' + response.owner.username + '</b></a></td></tr>'
        + '<tr><td>' + mytrans("geocache.type") + '</td><td>' + response.type + '</td></tr>'
        + '<tr><td>' + mytrans("geocache.size") + '</td><td>' + response.size2 + '</td></tr>'
        + '<tr><td>' + mytrans("geocache.status") + '</td><td>' + response.status + '</td></tr>'
        + '<tr><td>' + mytrans("geocache.difficulty") + '</td><td>' + response.difficulty + '/5</td></tr>'
        + '<tr><td>' + mytrans("geocache.terrain") + '</td><td>' + response.terrain + '/5</td></tr>'
        + '<tr><td>' + mytrans("geocache.finds") + '</td><td>' + response.founds + '</td></tr>'
        + '</table>';
    return content;
};


Okapi.showPopup = function (m, code, siteid) {
    'use strict';

    if (!this.m_popup) {
        this.m_popup = new google.maps.InfoWindow();
    }

    var self = this,
        site = this.m_sites[siteid];

    $.ajax({
        url: site.url + 'services/caches/geocache',
        dataType: 'json',
        data: {
            'consumer_key': site.key,
            'cache_code': code,
            'fields' : 'name|type|status|url|owner|founds|size2|difficulty|terrain|location'
        },
        success: function (response) {
            var coords = self.parseLocation(response.location);
            self.m_map.setCenter(coords);

            if (!m) {
                m = new google.maps.Marker({
                    position: coords,
                    map: self.m_map,
                    icon: self.icon(response.type)
                });
                if (self.m_maker) {
                    self.m_marker.setMap(null);
                }
                self.registerPopup(m, code, siteid);
                self.m_marker = m;
            }

            self.m_popup.setContent(self.createPopupContent(code, response));
            self.m_popup.open(self.m_map, m);
        }
    });
};


Okapi.registerPopup = function (m, code, siteid) {
    'use strict';

    if (!this.m_ready) {
        return;
    }

    var self = this;

    google.maps.event.addListener(m, 'click', function () {
        self.showPopup(m, code, siteid);
    });
};


Okapi.removeMarkers = function () {
    'use strict';

    if (!this.m_ready) {
        return;
    }

    var self = this;

    this.m_sites.map(function (site) {
        var key;
        for (key in site.markers) {
            if (!site.markers.hasOwnProperty(key)) {
                continue;
            }
            site.markers[key].setMap(null);
        }
        site.markers = {};
    });

    if (this.m_marker) {
        this.m_marker.setMap(null);
        delete this.m_marker;
        this.m_marker = null;
    }
};


Okapi.loadBboxSite = function (siteid) {
    'use strict';

    if (!this.m_ready) {
        return;
    }

    var self = this,
        site = this.m_sites[siteid],
        b,
        bbox;

    if (!this.m_enabled) {
        site.finished = true;
        return;
    }

    if (!site.finished) {
        return;
    }

    site.finished = false;

    b = this.m_map.getBounds();
    bbox = b.getSouthWest().lat() + "|" + b.getSouthWest().lng() + "|" + b.getNorthEast().lat() + "|" + b.getNorthEast().lng();

    $.ajax({
        url: site.url + 'services/caches/shortcuts/search_and_retrieve',
        dataType: 'json',
        data: {
            'consumer_key': site.key,
            'search_method': 'services/caches/search/bbox',
            'search_params': '{"bbox" : "' + bbox + '", "limit" : "500"}',
            'retr_method': 'services/caches/geocaches',
            'retr_params': '{"fields": "code|name|location|type|status|url"}',
            'wrap': 'false'
        },
        success: function (response) {
            var addedCaches = {},
                cache,
                code;

            for (code in response) {
                if (!response.hasOwnProperty(code)) {
                    continue;
                }

                cache = response[code];
                if (cache.status !== "Available") {
                    continue;
                }

                addedCaches[cache.code] = true;
                if (site.markers[cache.code] !== undefined) {
                    continue;
                }

                site.markers[cache.code] = new google.maps.Marker({
                    position: self.parseLocation(cache.location),
                    map: self.m_map,
                    icon: self.icon(cache.type)
                });

                self.registerPopup(site.markers[cache.code], cache.code, siteid);
            }

            for (code in site.markers) {
                if (site.markers.hasOwnProperty(code) && addedCaches[code] === undefined) {
                    site.markers[code].setMap(null);
                    delete site.markers[code];
                }
            }
            site.finished = true;
        },
        error: function () {
            //console.log("okapi request failed: " + site.name);
            self.removeMarkersSite(site.markers);
            site.markers = {};
            site.finished = true;
        }
    });
};


Okapi.loadBbox = function () {
    'use strict';

    if (!this.m_ready) {
        return;
    }

    var self = this;
    this.m_sites.map(function (site) {
        self.loadBboxSite(site.siteid);
    });
};


Okapi.unscheduleLoad = function () {
    'use strict';

    if (!this.m_ready) {
        return;
    }

    if (this.m_timer) {
        window.clearTimeout(this.m_timer);
        this.m_timer = null;
    }
};


Okapi.scheduleLoad = function () {
    'use strict';

    if (!this.m_ready) {
        return;
    }

    var self = this;

    this.unscheduleLoad();
    this.m_timer = window.setTimeout(function () {
        self.loadBbox();
    }, 500);
};


Okapi.toggle = function (t) {
    'use strict';

    Cookies.set('load_caches', t ? "1" : "0", {expires: 30});
    if ($('#geocaches').is(':checked') !== t) {
        $('#geocaches').attr('checked', t);
    }

    if (this.m_enabled !== t) {
        this.m_enabled = t;
    }

    if (this.m_enabled) {
        this.setupIcons();
        this.setupSites();
        this.scheduleLoad();
    } else {
        this.unscheduleLoad();
        this.removeMarkers();
    }
};


Okapi.restore = function (defaultValue) {
    'use strict';

    var state = get_cookie_string("load_caches", "invalid");

    if (state === "0") {
        this.toggle(false);
    } else if (state === "1") {
        this.toggle(true);
    } else {
        this.toggle(defaultValue);
    }
};


1			/*jslint
2			indent: 4
3			*/
4
5			/*global
6			$, google, mytrans, window, Cookies, Coordinates, get_cookie_string
7			*/
8
9
10			var Okapi = {};
11			Okapi.m_map = null;
12			Okapi.m_sites = null;
13			Okapi.m_ready = false;
14			Okapi.m_showCache = null;
15			Okapi.m_enabled = false;
16			Okapi.m_popup = null;
17			Okapi.m_marker = null;
18			Okapi.m_icons = null;
19			Okapi.m_timer = null;
20
21
22			Okapi.init = function (themap) {
23			'use strict';
24
25			this.m_map = themap;
26			var self = this;
27
28			google.maps.event.addListener(this.m_map, "center_changed", function () {
29			self.scheduleLoad();
30			});
31			google.maps.event.addListener(this.m_map, "zoom_changed", function () {
32			self.scheduleLoad();
33			});
34			};
35
36
37			Okapi.parseLocation = function (s) {
38			'use strict';
39
40			var loc = s.split("\|"),
41			lat = parseFloat(loc[0]),
42			lng = parseFloat(loc[1]);
43
44			if (Coordinates.valid(lat, lng)) {
45			return new google.maps.LatLng(lat, lng);
46			}
47
48			return null;
49			};
50
51
52			Okapi.setShowCache = function (code) {
53			'use strict';
54
55			this.m_showCache = code;
56			};
57
58
59			Okapi.setupSites = function () {
60			'use strict';
61
62			if (this.m_sites) {
63			return;
64			}
65
66			var self = this,
67			main_url = "http://www.opencaching.pl/okapi/services/apisrv/installations",
68			keys = {
69			"Opencaching.DE" : "YSqPufH82encfJ67ZxV2",
70			"Opencaching.PL" : "jhRyc6rGmT6XEvxva29B",
71			"Opencaching.NL" : "gcwaesuq3REu8RtCgLDj",
72			"Opencaching.US" : "GvgyCMvwfH42GqJGL494",
73			"Opencaching.ORG.UK" : "7t7VfpkCd4HuxPabfbHd",
74			"Opencaching.RO" : "gqSWmVJhZGDwc4sRhyy7"
75			},
76			prefixes = {
77			"Opencaching.DE" : "OC",
78			"Opencaching.PL" : "OP",
79			"Opencaching.NL" : "OB",
80			"Opencaching.US" : "OU",
81			"Opencaching.ORG.UK" : "OK",
82			"Opencaching.RO" : "OR"
83			};
84
85			this.m_sites = [];
86
87			$.ajax({
88			url: main_url,
89			dataType: 'json',
90			success: function (response) {
91			response.map(function (site) {
92			if (keys[site.site_name] !== undefined) {
93			//console.log("adding OC site: " + site.site_name);
94			self.m_sites.push({
95			siteid: self.m_sites.length,
96			name: site.site_name,
97			site_url: site.site_url,
98			url: site.okapi_base_url,
99			prefix: prefixes[site.site_name],
100			key: keys[site.site_name],
101			ignore_user: null,
102			markers: {},
103			finished: true
104			});
105			}
106			});
107
108			self.m_ready = true;
109			if (self.m_enabled) {
110			self.scheduleLoad(true);
111			}
112			if (self.m_showCache && self.m_showCache !== "") {
113			self.centerMap(self.m_showCache);
114			self.m_showCache = null;
115			}
116			}
117			});
118			};
119
120
121			Okapi.setupIcons = function () {
122			'use strict';
123
124			if (this.m_icons) {
125			return;
126			}
127
128			this.m_icons = {
129			"Other": new google.maps.MarkerImage("img/cachetype-1.png"),
130			"Traditional": new google.maps.MarkerImage("img/cachetype-2.png"),
131			"Multi": new google.maps.MarkerImage("img/cachetype-3.png"),
132			"Virtual": new google.maps.MarkerImage("img/cachetype-4.png"),
133			"Webcam": new google.maps.MarkerImage("img/cachetype-5.png"),
134			"Event": new google.maps.MarkerImage("img/cachetype-6.png"),
135			"Quiz": new google.maps.MarkerImage("img/cachetype-7.png"),
136			"Math/Physics": new google.maps.MarkerImage("img/cachetype-8.png"),
137			"Moving": new google.maps.MarkerImage("img/cachetype-9.png"),
138			"Drive-In": new google.maps.MarkerImage("img/cachetype-10.png")
139			};
140			};
141
142
143			Okapi.icon = function (type) {
144			'use strict';
145
146			if (this.m_icons[type] !== undefined) {
147			return this.m_icons[type];
148			}
149
150			return this.m_icons.Other;
151			};
152
153
154			Okapi.guessSiteId = function (code) {
155			'use strict';
156
157			code = code.toUpperCase();
158			var siteid;
159			for (siteid = 0; siteid < this.m_sites.length; siteid += 1) {
160			if (code.startsWith(this.m_sites[siteid].prefix)) {
161			return siteid;
162			}
163			}
164
165			return -1;
166			};
167
168
169			Okapi.centerMap = function (code) {
170			'use strict';
171
172			if (!this.m_ready) {
173			//console.log("okapi not ready");
174			return;
175			}
176
177			var siteid = this.guessSiteId(code);
178			if (siteid < 0) {
179			//console.log("bad code. cannot determine okapi site");
180			return;
181			}
182
183			this.showPopup(null, code.toUpperCase(), siteid);
184			};
185
186
187			Okapi.createPopupContent = function (code, response) {
188			'use strict';
189
190			var content =
191			'<a href="' + response.url + '" target="_blank">' + code + ' <b>' + response.name + '</b></a><br />'
192			+ '<table>'
193			+ '<tr><td>' + mytrans("geocache.owner") + '</td><td>' + '<a href="' + response.owner.profile_url + '" target="_blank"><b>' + response.owner.username + '</b></a></td></tr>'
194			+ '<tr><td>' + mytrans("geocache.type") + '</td><td>' + response.type + '</td></tr>'
195			+ '<tr><td>' + mytrans("geocache.size") + '</td><td>' + response.size2 + '</td></tr>'
196			+ '<tr><td>' + mytrans("geocache.status") + '</td><td>' + response.status + '</td></tr>'
197			+ '<tr><td>' + mytrans("geocache.difficulty") + '</td><td>' + response.difficulty + '/5</td></tr>'
198			+ '<tr><td>' + mytrans("geocache.terrain") + '</td><td>' + response.terrain + '/5</td></tr>'
199			+ '<tr><td>' + mytrans("geocache.finds") + '</td><td>' + response.founds + '</td></tr>'
200			+ '</table>';
201			return content;
202			};
203
204
205			Okapi.showPopup = function (m, code, siteid) {
206			'use strict';
207
208			if (!this.m_popup) {
209			this.m_popup = new google.maps.InfoWindow();
210			}
211
212			var self = this,
213			site = this.m_sites[siteid];
214
215			$.ajax({
216			url: site.url + 'services/caches/geocache',
217			dataType: 'json',
218			data: {
219			'consumer_key': site.key,
220			'cache_code': code,
221			'fields' : 'name\|type\|status\|url\|owner\|founds\|size2\|difficulty\|terrain\|location'
222			},
223			success: function (response) {
224			var coords = self.parseLocation(response.location);
225			self.m_map.setCenter(coords);
226
227			if (!m) {
228			m = new google.maps.Marker({
229			position: coords,
230			map: self.m_map,
231			icon: self.icon(response.type)
232			});
233			if (self.m_maker) {
234			self.m_marker.setMap(null);
235			}
236			self.registerPopup(m, code, siteid);
237			self.m_marker = m;
238			}
239
240			self.m_popup.setContent(self.createPopupContent(code, response));
241			self.m_popup.open(self.m_map, m);
242			}
243			});
244			};
245
246
247			Okapi.registerPopup = function (m, code, siteid) {
248			'use strict';
249
250			if (!this.m_ready) {
251			return;
252			}
253
254			var self = this;
255
256			google.maps.event.addListener(m, 'click', function () {
257			self.showPopup(m, code, siteid);
258			});
259			};
260
261
262			Okapi.removeMarkers = function () {
263			'use strict';
264
265			if (!this.m_ready) {
266			return;
267			}
268
269			var self = this;
			0 ignored issues – show Unused Code introduced 2016-07-28 18:06 UTC by Report Bug Copy Issue Report The variable `self` seems to be never used. Consider removing it. Loading history...
270			this.m_sites.map(function (site) {
271			var key;
272			for (key in site.markers) {
273			if (!site.markers.hasOwnProperty(key)) {
274			continue;
275			}
276			site.markers[key].setMap(null);
277			}
278			site.markers = {};
279			});
280
281			if (this.m_marker) {
282			this.m_marker.setMap(null);
283			delete this.m_marker;
284			this.m_marker = null;
285			}
286			};
287
288
289			Okapi.loadBboxSite = function (siteid) {
290			'use strict';
291
292			if (!this.m_ready) {
293			return;
294			}
295
296			var self = this,
297			site = this.m_sites[siteid],
298			b,
299			bbox;
300
301			if (!this.m_enabled) {
302			site.finished = true;
303			return;
304			}
305
306			if (!site.finished) {
307			return;
308			}
309
310			site.finished = false;
311
312			b = this.m_map.getBounds();
313			bbox = b.getSouthWest().lat() + "\|" + b.getSouthWest().lng() + "\|" + b.getNorthEast().lat() + "\|" + b.getNorthEast().lng();
314
315			$.ajax({
316			url: site.url + 'services/caches/shortcuts/search_and_retrieve',
317			dataType: 'json',
318			data: {
319			'consumer_key': site.key,
320			'search_method': 'services/caches/search/bbox',
321			'search_params': '{"bbox" : "' + bbox + '", "limit" : "500"}',
322			'retr_method': 'services/caches/geocaches',
323			'retr_params': '{"fields": "code\|name\|location\|type\|status\|url"}',
324			'wrap': 'false'
325			},
326			success: function (response) {
327			var addedCaches = {},
328			cache,
329			code;
330
331			for (code in response) {
332			if (!response.hasOwnProperty(code)) {
333			continue;
334			}
335
336			cache = response[code];
337			if (cache.status !== "Available") {
338			continue;
339			}
340
341			addedCaches[cache.code] = true;
342			if (site.markers[cache.code] !== undefined) {
343			continue;
344			}
345
346			site.markers[cache.code] = new google.maps.Marker({
347			position: self.parseLocation(cache.location),
348			map: self.m_map,
349			icon: self.icon(cache.type)
350			});
351
352			self.registerPopup(site.markers[cache.code], cache.code, siteid);
353			}
354
355			for (code in site.markers) {
356			if (site.markers.hasOwnProperty(code) && addedCaches[code] === undefined) {
357			site.markers[code].setMap(null);
358			delete site.markers[code];
359			}
360			}
361			site.finished = true;
362			},
363			error: function () {
364			//console.log("okapi request failed: " + site.name);
365			self.removeMarkersSite(site.markers);
366			site.markers = {};
367			site.finished = true;
368			}
369			});
370			};
371
372
373			Okapi.loadBbox = function () {
374			'use strict';
375
376			if (!this.m_ready) {
377			return;
378			}
379
380			var self = this;
381			this.m_sites.map(function (site) {
382			self.loadBboxSite(site.siteid);
383			});
384			};
385
386
387			Okapi.unscheduleLoad = function () {
388			'use strict';
389
390			if (!this.m_ready) {
391			return;
392			}
393
394			if (this.m_timer) {
395			window.clearTimeout(this.m_timer);
396			this.m_timer = null;
397			}
398			};
399
400
401			Okapi.scheduleLoad = function () {
402			'use strict';
403
404			if (!this.m_ready) {
405			return;
406			}
407
408			var self = this;
409
410			this.unscheduleLoad();
411			this.m_timer = window.setTimeout(function () {
412			self.loadBbox();
413			}, 500);
414			};
415
416
417			Okapi.toggle = function (t) {
418			'use strict';
419
420			Cookies.set('load_caches', t ? "1" : "0", {expires: 30});
421			if ($('#geocaches').is(':checked') !== t) {
422			$('#geocaches').attr('checked', t);
423			}
424
425			if (this.m_enabled !== t) {
426			this.m_enabled = t;
427			}
428
429			if (this.m_enabled) {
430			this.setupIcons();
431			this.setupSites();
432			this.scheduleLoad();
433			} else {
434			this.unscheduleLoad();
435			this.removeMarkers();
436			}
437			};
438
439
440			Okapi.restore = function (defaultValue) {
441			'use strict';
442
443			var state = get_cookie_string("load_caches", "invalid");
444
445			if (state === "0") {
446			this.toggle(false);
447			} else if (state === "1") {
448			this.toggle(true);
449			} else {
450			this.toggle(defaultValue);
451			}
452			};
453

flopp / FloppsMap

GitHub Access Token became invalid

Push — master ( 92186c...418fbb )

Okapi.setupSites A

Complexity

Size

Duplication

Importance

1 Function

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like